doc: update readline docs on EOL handling #4927
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mscdex
added
doc
| @@ -118,7 +118,7 @@ the `input` stream receives a `^C`, respectively known as `SIGINT`. | |||
|
|
|||
| `function (line) {}` | |||
|
|
|||
| Emitted whenever the `input` stream receives a `\n`, usually received when the | |||
| Emitted whenever the `input` stream receives `EOL`, usually received when the | |||
There was a problem hiding this comment.
This could be clearer if we explicitly said "end of line (\n, \r, or \r\n)"
There was a problem hiding this comment.
Sounds good, will fix.
|
LGTM with a suggestion. |
kthelgason
force-pushed
the
readline-doc-fix
branch
from
8f2f779 to
537cb07
Compare
|
Fixed according to @cjihrig's suggestion. |
|
Thanks! Landed in 3218dfb. |
|
Added the lts-watch label. Doc updates like this should generally always be on the lts watch list unless they depend on a semver-minor or major. |
Merged
scovetta
pushed a commit
to scovetta/node
that referenced
this pull request
Apr 2, 2016
This commit explicitly calls out the end of line sequences used to generate line events in the readline module. Fixes: nodejs#4916 PR-URL: nodejs#4927 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As raised in #4916 readline actually handles all the various forms of EOL (
\r,\r\n,\n).